<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpui: GIMP 3 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP 3 Library Reference Manual">
<link rel="up" href="libgimpui.html" title="Part II. GIMP User Interface Library">
<link rel="prev" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="next" href="libgimp3-gimpexport.html" title="gimpexport">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgimp3-gimpui.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimpui.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimpui-hierarchy.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp3-gimpexport.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp3-gimpui"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp3-gimpui.top_of_page"></a>gimpui</span></h2>
<p>gimpui — Common user interface functions. This header includes
all other GIMP User Interface Library headers.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp3-gimpui.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpui.html#gimp-ui-init" title="gimp_ui_init ()">gimp_ui_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/gdk3/gdk3-Windows.html#GdkWindow-struct"><span class="returnvalue">GdkWindow</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpui.html#gimp-ui-get-display-window" title="gimp_ui_get_display_window ()">gimp_ui_get_display_window</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/gdk3/gdk3-Windows.html#GdkWindow-struct"><span class="returnvalue">GdkWindow</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpui.html#gimp-ui-get-progress-window" title="gimp_ui_get_progress_window ()">gimp_ui_get_progress_window</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpui.html#gimp-window-set-transient" title="gimp_window_set_transient ()">gimp_window_set_transient</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpui.html#gimp-window-set-transient-for-display" title="gimp_window_set_transient_for_display ()">gimp_window_set_transient_for_display</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp3-gimpui.description"></a><h2>Description</h2>
<p>Common user interface functions. This header includes all other
GIMP User Interface Library headers.</p>
</div>
<div class="refsect1">
<a name="libgimp3-gimpui.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-ui-init"></a><h3>gimp_ui_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_ui_init (<em class="parameter"><code>const <span class="type">gchar</span> *prog_name</code></em>);</pre>
<p>This function initializes GTK+ with <a href="https://developer.gnome.org/gtk3/gtk3-General.html#gtk-init"><code class="function">gtk_init()</code></a>.</p>
<p>It also sets up various other things so that the plug-in user looks
and behaves like the GIMP core. This includes selecting the GTK+
theme and setting up the help system as chosen in the GIMP
preferences. Any plug-in that provides a user interface should call
this function.</p>
<div class="refsect3">
<a name="gimp-ui-init.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>prog_name</p></td>
<td class="parameter_description"><p>The name of the plug-in which will be passed as argv[0] to
<a href="https://developer.gnome.org/gtk3/gtk3-General.html#gtk-init"><code class="function">gtk_init()</code></a>. It's a convention to use the name of the
executable and _not_ the PDB procedure name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-ui-get-display-window"></a><h3>gimp_ui_get_display_window ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/gdk3/gdk3-Windows.html#GdkWindow-struct"><span class="returnvalue">GdkWindow</span></a> *
gimp_ui_get_display_window (<em class="parameter"><code><a class="link" href="GimpDisplay.html" title="gimpdisplay"><span class="type">GimpDisplay</span></a> *display</code></em>);</pre>
<p>Returns the <a href="https://developer.gnome.org/gdk3/gdk3-Windows.html#GdkWindow-struct"><span class="type">GdkWindow</span></a> of a display window. The purpose is to allow
to make plug-in dialogs transient to the image display as explained
with <a href="https://developer.gnome.org/gdk3/gdk3-Windows.html#gdk-window-set-transient-for"><code class="function">gdk_window_set_transient_for()</code></a>.</p>
<p>You shouldn't have to call this function directly. Use
<a class="link" href="libgimp3-gimpui.html#gimp-window-set-transient-for-display" title="gimp_window_set_transient_for_display ()"><code class="function">gimp_window_set_transient_for_display()</code></a> instead.</p>
<div class="refsect3">
<a name="gimp-ui-get-display-window.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>display</p></td>
<td class="parameter_description"><p>a <a class="link" href="GimpDisplay.html" title="gimpdisplay"><span class="type">GimpDisplay</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-ui-get-display-window.returns"></a><h4>Returns</h4>
<p>A reference to a <a href="https://developer.gnome.org/gdk3/gdk3-Windows.html#GdkWindow-struct"><span class="type">GdkWindow</span></a> or <code class="literal">NULL</code>.
You should unref the window using <code class="function">g_object_unref()</code> as
soon as you don't need it any longer. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-ui-get-progress-window"></a><h3>gimp_ui_get_progress_window ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/gdk3/gdk3-Windows.html#GdkWindow-struct"><span class="returnvalue">GdkWindow</span></a> *
gimp_ui_get_progress_window (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the <a href="https://developer.gnome.org/gdk3/gdk3-Windows.html#GdkWindow-struct"><span class="type">GdkWindow</span></a> of the window this plug-in's progress bar is
shown in. Use it to make plug-in dialogs transient to this window
as explained with <a href="https://developer.gnome.org/gdk3/gdk3-Windows.html#gdk-window-set-transient-for"><code class="function">gdk_window_set_transient_for()</code></a>.</p>
<p>You shouldn't have to call this function directly. Use
<a class="link" href="libgimp3-gimpui.html#gimp-window-set-transient" title="gimp_window_set_transient ()"><code class="function">gimp_window_set_transient()</code></a> instead.</p>
<div class="refsect3">
<a name="gimp-ui-get-progress-window.returns"></a><h4>Returns</h4>
<p>A reference to a <a href="https://developer.gnome.org/gdk3/gdk3-Windows.html#GdkWindow-struct"><span class="type">GdkWindow</span></a> or <code class="literal">NULL</code>.
You should unref the window using <code class="function">g_object_unref()</code> as
soon as you don't need it any longer. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-window-set-transient"></a><h3>gimp_window_set_transient ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_window_set_transient (<em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *window</code></em>);</pre>
<p>Indicates to the window manager that <em class="parameter"><code>window</code></em>
 is a transient dialog
associated with the GIMP window that the plug-in has been
started from. See also <a class="link" href="libgimp3-gimpui.html#gimp-window-set-transient-for-display" title="gimp_window_set_transient_for_display ()"><code class="function">gimp_window_set_transient_for_display()</code></a>.</p>
<div class="refsect3">
<a name="gimp-window-set-transient.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>window</p></td>
<td class="parameter_description"><p>the <a href="https://developer.gnome.org/gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> that should become transient</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-window-set-transient-for-display"></a><h3>gimp_window_set_transient_for_display ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_window_set_transient_for_display (<em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *window</code></em>,
                                       <em class="parameter"><code><a class="link" href="GimpDisplay.html" title="gimpdisplay"><span class="type">GimpDisplay</span></a> *display</code></em>);</pre>
<p>Indicates to the window manager that <em class="parameter"><code>window</code></em>
 is a transient dialog
associated with the GIMP image window that is identified by it's
display ID. See <a href="https://developer.gnome.org/gdk3/gdk3-Windows.html#gdk-window-set-transient-for"><code class="function">gdk_window_set_transient_for()</code></a> for more information.</p>
<p>Most of the time you will want to use the convenience function
<a class="link" href="libgimp3-gimpui.html#gimp-window-set-transient" title="gimp_window_set_transient ()"><code class="function">gimp_window_set_transient()</code></a>.</p>
<div class="refsect3">
<a name="gimp-window-set-transient-for-display.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>window</p></td>
<td class="parameter_description"><p>the <a href="https://developer.gnome.org/gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> that should become transient</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>display</p></td>
<td class="parameter_description"><p>display of the image window that should become the parent</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="libgimp3-gimpui.see-also"></a><h2>See Also</h2>
<p>gtk_init(), <code class="function">gdk_set_use_xshm()</code>, <code class="function">gtk_widget_set_default_visual()</code>.</p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>